Skip to content

fix: make studio reindex more robust, provide better logging (backport of #38498)#38542

Merged
farhaanbukhsh merged 1 commit intoopenedx:release/verawoodfrom
open-craft:braden/fix-reindex-bugs-verawood
May 5, 2026
Merged

fix: make studio reindex more robust, provide better logging (backport of #38498)#38542
farhaanbukhsh merged 1 commit intoopenedx:release/verawoodfrom
open-craft:braden/fix-reindex-bugs-verawood

Conversation

@bradenmacdonald
Copy link
Copy Markdown
Contributor

@bradenmacdonald bradenmacdonald commented May 5, 2026

This backports #38498 to Verawood:

  1. Improves the reindex_studio management command so that it will gracefully log and continue when it tries to index a deleted course, rather than crashing.

    • The list of course IDs is retrieved from CourseOverview, but if there is a CourseOverview entry that no longer exists in modulestore, the whole reindex process would crash.

  2. Addresses a warning seen when running reindex_studio:

    UnorderedObjectListWarning: Pagination may yield inconsistent results with an unordered object_list:
<class 'openedx.core.djangoapps.content.course_overviews.models.CourseOverview'> QuerySet.

  3. Improves the logging when resuming an interrupted reindex. In such cases, it would say something like "Found 28 courses, 0 libraries." even when you have more courses or libraries than that, which was confusing. It now explicitly says "Resuming incremental index - NNN courses/libraries already indexed."

  4. Fixes a bug where a library could be marked as indexed before its containers were fully indexed.

  5. Improves formatting and verbosity of the logging.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels May 5, 2026
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented May 5, 2026

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions May 5, 2026
farhaanbukhsh
farhaanbukhsh approved these changes May 5, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@farhaanbukhsh farhaanbukhsh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

✅ I tested this:

  • The main code on the master branch
  • Tested it on verawood branch as well.

✅ I read through the code
❌ I checked for accessibility issues
❌ Includes documentation

@farhaanbukhsh farhaanbukhsh merged commit f151fb1 into openedx:release/verawood May 5, 2026
42 checks passed
@farhaanbukhsh farhaanbukhsh deleted the braden/fix-reindex-bugs-verawood branch May 5, 2026 12:09
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions May 5, 2026
@farhaanbukhsh
Copy link
Copy Markdown
Member

farhaanbukhsh commented May 5, 2026

Thanks @bradenmacdonald for the work here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@farhaanbukhsh farhaanbukhsh farhaanbukhsh approved these changes

Assignees

No one assigned

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bradenmacdonald @openedx-webhooks @farhaanbukhsh